package de.roettger_it.jmoviepilot.util;

import java.net.URL;

/**
 * This class contains information about a neighbour of a specific movie.
 * The neighbour is a movie that is similar to this specific movie.
 * 
 * @author Tobias Roettger
 *
 */
public class Neighbour
{	
	private Movie neighbour_movie;
	
	private Double distance;
	
	private URL movie_restful_url;
	private URL restful_url;
	
	/**
	 * Gets the distance of the neighbour to a specific movie.
	 * 
	 * @return the distance of the neighbour to a movie
	 */
	public Double getDistance()
	{
		return distance;
	}
	
	/**
	 * Sets the distance of the neighbour to a specific movie.
	 * 
	 * @param distance the distance to set
	 */
	public void setDistance(double distance)
	{
		this.distance = distance;
	}
	
	/**
	 * Gets the Movie that is represented by the neighbour.
	 * 
	 * @return the neighbour Movie instance.
	 */
	public Movie getMovie()
	{
		return neighbour_movie;
	}
	
	/**
	 * Sets the Movie that is represented by the neighbour.
	 * 
	 * @param neighbourMovie the Movie instance to set
	 */
	public void setMovie(Movie neighbourMovie)
	{
		this.neighbour_movie = neighbourMovie;
	}
	
	/**
	 * Gets the restful URL of the movie to which the neighbour is related to.
	 *  
	 * @return the restful URL of the related movie
	 */
	public URL getMovieRestfulURL()
	{
		return movie_restful_url;
	}
	
	/**
	 * Sets the restul URL of the movie to which the neighbour is related to.
	 * 
	 * @param movieRestfulURL the restful URL of the related movie to set
	 */
	public void setMovieRestfulURL(URL movieRestfulURL)
	{
		this.movie_restful_url = movieRestfulURL;
	}
	
	/**
	 * Gets the restful URL of the neighbour.
	 * 
	 * @return the restful URL of the neighbour
	 */
	public URL getRestfulURL()
	{
		return restful_url;
	}
	
	/**
	 * Sets the restful URL of the neighbour.
	 * 
	 * @param restfulURL the restful URL to set
	 */
	public void setRestfulURL(URL restfulURL)
	{
		this.restful_url = restfulURL;
	}
}
